3 * Context for ResourceLoader modules.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @author Trevor Parscal
22 * @author Roan Kattouw
25 use MediaWiki\Logger\LoggerFactory
;
26 use MediaWiki\MediaWikiServices
;
29 * Object passed around to modules which contains information about the state
30 * of a specific loader request.
32 class ResourceLoaderContext
implements MessageLocalizer
{
33 protected $resourceLoader;
37 // Module content vary
43 // Request vary (in addition to cache vary)
58 * @param ResourceLoader $resourceLoader
59 * @param WebRequest $request
61 public function __construct( ResourceLoader
$resourceLoader, WebRequest
$request ) {
62 $this->resourceLoader
= $resourceLoader;
63 $this->request
= $request;
64 $this->logger
= $resourceLoader->getLogger();
66 // Future developers: Use WebRequest::getRawVal() instead getVal().
67 // The getVal() method performs slow Language+UTF logic. (f303bb9360)
70 $modules = $request->getRawVal( 'modules' );
71 $this->modules
= $modules ? self
::expandModuleNames( $modules ) : [];
74 $this->user
= $request->getRawVal( 'user' );
75 $this->debug
= $request->getRawVal( 'debug' ) === 'true';
76 $this->only
= $request->getRawVal( 'only', null );
77 $this->version
= $request->getRawVal( 'version', null );
78 $this->raw
= $request->getFuzzyBool( 'raw' );
81 $this->image
= $request->getRawVal( 'image' );
82 $this->variant
= $request->getRawVal( 'variant' );
83 $this->format
= $request->getRawVal( 'format' );
85 $this->skin
= $request->getRawVal( 'skin' );
86 $skinnames = Skin
::getSkinNames();
87 // If no skin is specified, or we don't recognize the skin, use the default skin
88 if ( !$this->skin ||
!isset( $skinnames[$this->skin
] ) ) {
89 $this->skin
= $this->getConfig()->get( 'DefaultSkin' );
94 * Expand a string of the form `jquery.foo,bar|jquery.ui.baz,quux` to
95 * an array of module names like `[ 'jquery.foo', 'jquery.bar',
96 * 'jquery.ui.baz', 'jquery.ui.quux' ]`.
98 * This process is reversed by ResourceLoader::makePackedModulesString().
100 * @param string $modules Packed module name list
101 * @return array Array of module names
103 public static function expandModuleNames( $modules ) {
105 $exploded = explode( '|', $modules );
106 foreach ( $exploded as $group ) {
107 if ( strpos( $group, ',' ) === false ) {
108 // This is not a set of modules in foo.bar,baz notation
109 // but a single module
112 // This is a set of modules in foo.bar,baz notation
113 $pos = strrpos( $group, '.' );
114 if ( $pos === false ) {
115 // Prefixless modules, i.e. without dots
116 $retval = array_merge( $retval, explode( ',', $group ) );
118 // We have a prefix and a bunch of suffixes
119 $prefix = substr( $group, 0, $pos ); // 'foo'
120 $suffixes = explode( ',', substr( $group, $pos +
1 ) ); // [ 'bar', 'baz' ]
121 foreach ( $suffixes as $suffix ) {
122 $retval[] = "$prefix.$suffix";
131 * Return a dummy ResourceLoaderContext object suitable for passing into
132 * things that don't "really" need a context.
135 * - Creating html5shiv script tag in OutputPage.
136 * - Unit tests (deprecated, create empty instance directly or use RLTestCase).
138 * @return ResourceLoaderContext
140 public static function newDummyContext() {
141 // This currently creates a non-empty instance of ResourceLoader (all modules registered),
142 // but that's probably not needed. So once that moves into ServiceWiring, this'll
143 // become more like the EmptyResourceLoader class we have in PHPUnit tests, which
144 // is what this should've had originally. If this turns out to be untrue, change to:
145 // `MediaWikiServices::getInstance()->getResourceLoader()` instead.
146 return new self( new ResourceLoader(
147 MediaWikiServices
::getInstance()->getMainConfig(),
148 LoggerFactory
::getInstance( 'resourceloader' )
149 ), new FauxRequest( [] ) );
153 * @return ResourceLoader
155 public function getResourceLoader() {
156 return $this->resourceLoader
;
162 public function getConfig() {
163 return $this->getResourceLoader()->getConfig();
169 public function getRequest() {
170 return $this->request
;
175 * @return \Psr\Log\LoggerInterface
177 public function getLogger() {
178 return $this->logger
;
184 public function getModules() {
185 return $this->modules
;
191 public function getLanguage() {
192 if ( $this->language
=== null ) {
193 // Must be a valid language code after this point (T64849)
194 // Only support uselang values that follow built-in conventions (T102058)
195 $lang = $this->getRequest()->getRawVal( 'lang', '' );
196 // Stricter version of RequestContext::sanitizeLangCode()
197 if ( !Language
::isValidBuiltInCode( $lang ) ) {
198 $lang = $this->getConfig()->get( 'LanguageCode' );
200 $this->language
= $lang;
202 return $this->language
;
208 public function getDirection() {
209 if ( $this->direction
=== null ) {
210 $this->direction
= $this->getRequest()->getRawVal( 'dir' );
211 if ( !$this->direction
) {
212 // Determine directionality based on user language (T8100)
213 $this->direction
= Language
::factory( $this->getLanguage() )->getDir();
216 return $this->direction
;
222 public function getSkin() {
227 * @return string|null
229 public function getUser() {
234 * Get a Message object with context set. See wfMessage for parameters.
237 * @param string|string[]|MessageSpecifier $key Message key, or array of keys,
238 * or a MessageSpecifier.
239 * @param mixed $args,...
242 public function msg( $key ) {
243 return wfMessage( ...func_get_args() )
244 ->inLanguage( $this->getLanguage() )
245 // Use a dummy title because there is no real title
246 // for this endpoint, and the cache won't vary on it
248 ->title( Title
::newFromText( 'Dwimmerlaik' ) );
252 * Get the possibly-cached User object for the specified username
257 public function getUserObj() {
258 if ( $this->userObj
=== null ) {
259 $username = $this->getUser();
261 // Use provided username if valid, fallback to anonymous user
262 $this->userObj
= User
::newFromName( $username ) ?
: new User
;
265 $this->userObj
= new User
;
269 return $this->userObj
;
275 public function getDebug() {
280 * @return string|null
282 public function getOnly() {
287 * @see ResourceLoaderModule::getVersionHash
288 * @see ResourceLoaderClientHtml::makeLoad
289 * @return string|null
291 public function getVersion() {
292 return $this->version
;
298 public function getRaw() {
303 * @return string|null
305 public function getImage() {
310 * @return string|null
312 public function getVariant() {
313 return $this->variant
;
317 * @return string|null
319 public function getFormat() {
320 return $this->format
;
324 * If this is a request for an image, get the ResourceLoaderImage object.
327 * @return ResourceLoaderImage|bool false if a valid object cannot be created
329 public function getImageObj() {
330 if ( $this->imageObj
=== null ) {
331 $this->imageObj
= false;
333 if ( !$this->image
) {
334 return $this->imageObj
;
337 $modules = $this->getModules();
338 if ( count( $modules ) !== 1 ) {
339 return $this->imageObj
;
342 $module = $this->getResourceLoader()->getModule( $modules[0] );
343 if ( !$module ||
!$module instanceof ResourceLoaderImageModule
) {
344 return $this->imageObj
;
347 $image = $module->getImage( $this->image
, $this );
349 return $this->imageObj
;
352 $this->imageObj
= $image;
355 return $this->imageObj
;
359 * Return the replaced-content mapping callback
361 * When editing a page that's used to generate the scripts or styles of a
362 * ResourceLoaderWikiModule, a preview should use the to-be-saved version of
363 * the page rather than the current version in the database. A context
364 * supporting such previews should return a callback to return these
368 * @return callable|null Signature is `Content|null func( Title $t )`
370 public function getContentOverrideCallback() {
377 public function shouldIncludeScripts() {
378 return $this->getOnly() === null ||
$this->getOnly() === 'scripts';
384 public function shouldIncludeStyles() {
385 return $this->getOnly() === null ||
$this->getOnly() === 'styles';
391 public function shouldIncludeMessages() {
392 return $this->getOnly() === null;
396 * All factors that uniquely identify this request, except 'modules'.
398 * The list of modules is excluded here for legacy reasons as most callers already
399 * split up handling of individual modules. Including it here would massively fragment
400 * the cache and decrease its usefulness.
402 * E.g. Used by RequestFileCache to form a cache key for storing the reponse output.
406 public function getHash() {
407 if ( !isset( $this->hash
) ) {
408 $this->hash
= implode( '|', [
409 // Module content vary
410 $this->getLanguage(),